home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1996 January: Mac OS SDK / Dev.CD Jan 96 SDK / Dev.CD Jan 96 SDK1.toast / Development Kits (Disc 1) / AppleScript / Development Tools / Interfaces / AppleScript 1.0 Interfaces / PInterfaces / Components.p < prev    next >
Encoding:
Text File  |  1993-04-08  |  8.2 KB  |  247 lines  |  [TEXT/MPS ]
  1. { 
  2. Created: Wednesday, January 27, 1992 at 5:31 PM
  3.  Components.p
  4.  Pascal Interface to the Macintosh Libraries
  5.  
  6.  Copyright Apple Computer, Inc. 1991, 1992
  7.  All rights reserved
  8. }
  9.  
  10.  
  11. {$IFC UNDEFINED UsingIncludes}
  12. {$SETC UsingIncludes := 0}
  13. {$ENDC}
  14.  
  15. {$IFC NOT UsingIncludes}
  16.  UNIT Components;
  17.  INTERFACE
  18. {$ENDC}
  19.  
  20. {$IFC UNDEFINED UsingComponents}
  21. {$SETC UsingComponents := 1}
  22.  
  23. {$I+}
  24. {$SETC ComponentsIncludes := UsingIncludes}
  25. {$SETC UsingIncludes := 1}
  26. {$IFC UNDEFINED UsingTypes}
  27. {$I $$Shell(PInterfaces)Types.p}
  28. {$ENDC}
  29. {$IFC UNDEFINED UsingTypes}
  30. {$I $$Shell(PInterfaces)Memory.p}
  31. {$ENDC}
  32. {$SETC UsingIncludes := ComponentsIncludes}
  33.  
  34. CONST
  35. gestaltComponentMgr = 'cpnt';
  36.  
  37. kAnyComponentType =            0;
  38. kAnyComponentSubType =         0;
  39. kAnyComponentManufacturer =    0;
  40. kAnyComponentFlagsMask =    0;
  41.  
  42. cmpWantsRegisterMessage = $80000000;
  43.  
  44.  
  45. TYPE
  46. ComponentDescription = RECORD
  47.  componentType: OSType;                                { A unique 4-byte code indentifying the command set }
  48.  componentSubType: OSType;                            { Particular flavor of this instance }
  49.  componentManufacturer: OSType;                        { Vendor indentification }
  50.  componentFlags: LONGINT;                            { 8 each for Component,Type,SubType,Manuf/revision }
  51.  componentFlagsMask: LONGINT;                        { Mask for specifying which flags to consider in search, zero during registration }
  52.  END;
  53.  
  54. ResourceSpec = RECORD
  55.  resType: OSType;                                    { 4-byte code  }
  56.  resId: INTEGER;                                    {    }
  57.  END;
  58.  
  59. ComponentResourcePtr = ^ComponentResource;
  60. ComponentResourceHandle = ^ComponentResourcePtr;
  61. ComponentResource = RECORD
  62.  cd: ComponentDescription;                            { Registration parameters }
  63.  component: ResourceSpec;                            { resource where Component code is found }
  64.  componentName: ResourceSpec;                        { name string resource }
  65.  componentInfo: ResourceSpec;                        { info string resource }
  66.  componentIcon: ResourceSpec;                        { icon resource }
  67.  END;
  68.  
  69. ComponentPtr = ^Component;
  70. Component = ^ComponentRecord;
  71. ComponentRecord = RECORD
  72.  data: ARRAY [0..0] OF LONGINT;
  73.  END;
  74.  
  75. ComponentInstance = ^ComponentInstanceRecord;
  76. ComponentInstanceRecord = RECORD
  77.  data: ARRAY [0..0] OF LONGINT;
  78.  END;
  79.  
  80. { Structure received by Component:  }
  81. ComponentParameters = PACKED RECORD
  82.  flags: CHAR;                                        { call modifiers: sync/async, deferred, immed, etc }
  83.  paramSize: CHAR;                                    { size in bytes of actual parameters passed to this call }
  84.  what: INTEGER;                                        { routine selector, negative for Component management calls }
  85.  params: ARRAY [0..0] OF LONGINT;                    { actual parameters for the indicated routine }
  86.  END;
  87.  
  88. ComponentResult = LONGINT;
  89.  
  90. ComponentRoutine = ProcPtr;
  91.  
  92. ComponentFunction = ProcPtr;
  93.  
  94.  
  95. {******************************************************
  96. * Required Component routines
  97. ******************************************************}
  98.  
  99. CONST
  100. kComponentOpenSelect = -1;                            { ComponentInstance for this open }
  101. kComponentCloseSelect = -2;                            { ComponentInstance for this close }
  102. kComponentCanDoSelect = -3;                            { selector # being queried }
  103. kComponentVersionSelect = -4;                        { no params }
  104. kComponentRegisterSelect = -5;                        { no params }
  105. kComponentTargetSelect = -6;                        { ComponentInstance for top of call chain }
  106.  
  107. { Set Default Component flags }
  108. defaultComponentIdentical = 0;
  109. defaultComponentAnyFlags = 1;
  110. defaultComponentAnyManufacturer = 2;
  111. defaultComponentAnySubType = 4;
  112. defaultComponentAnyFlagsAnyManufacturer = defaultComponentAnyFlags+defaultComponentAnyManufacturer;
  113. defaultComponentAnyFlagsAnyManufacturerAnySubType = defaultComponentAnyFlags+defaultComponentAnyManufacturer+defaultComponentAnySubType;
  114.  
  115. { errors from component manager & components }
  116. invalidComponentID = -3000;
  117. validInstancesExist = -3001;
  118. componentNotCaptured = -3002;
  119. componentDontRegister = -3003;
  120.  
  121. badComponentInstance = $80008001;
  122. badComponentSelector = $80008002;
  123.  
  124.  
  125. { *******************************************************
  126. *                                                     *
  127. *              APPLICATION LEVEL CALLS                *
  128. *                                                     *
  129. *******************************************************
  130. * Component Database Add, Delete, and Query Routines 
  131. *******************************************************
  132.  }
  133. FUNCTION RegisterComponent(cd: ComponentDescription;componentEntryPoint: ComponentRoutine;
  134.  global: INTEGER;componentName: Handle;componentInfo: Handle;componentIcon: Handle): Component;
  135.  INLINE $7001,$A82A;
  136. FUNCTION RegisterComponentResource(tr: ComponentResourceHandle;global: INTEGER): Component;
  137.  INLINE $7012,$A82A;
  138. FUNCTION UnregisterComponent(aComponent: Component): OSErr;
  139.  INLINE $7002,$A82A;
  140.  
  141. FUNCTION FindNextComponent(aComponent: Component;looking: ComponentDescription): Component;
  142.  INLINE $7004,$A82A;
  143. FUNCTION CountComponents(looking: ComponentDescription): LONGINT;
  144.  INLINE $7003,$A82A;
  145.  
  146. FUNCTION GetComponentInfo(aComponent: Component;VAR cd: ComponentDescription;
  147.  componentName: Handle;componentInfo: Handle;componentIcon: Handle): OSErr;
  148.  INLINE $7005,$A82A;
  149. FUNCTION GetComponentListModSeed: LONGINT;
  150.  INLINE $7006,$A82A;
  151.  
  152.  
  153. { *******************************************************
  154. * Component Instance Allocation and dispatch routines 
  155. *******************************************************
  156.  }
  157. FUNCTION OpenComponent(aComponent: Component): ComponentInstance;
  158.  INLINE $7007,$A82A;
  159. FUNCTION CloseComponent(aComponentInstance: ComponentInstance): OSErr;
  160.  INLINE $7008,$A82A;
  161.  
  162. FUNCTION GetComponentInstanceError(aComponentInstance: ComponentInstance): OSErr;
  163.  INLINE $700A,$A82A;
  164.  
  165.  
  166. {  direct calls to the Components  }
  167. FUNCTION ComponentFunctionImplemented(ci: ComponentInstance;ftnNumber: INTEGER): LONGINT;
  168.  INLINE $2F3C,$2,$FFFD,$7000,$A82A;
  169. FUNCTION GetComponentVersion(ci: ComponentInstance): LONGINT;
  170.  INLINE $2F3C,$0,$FFFC,$7000,$A82A;
  171. FUNCTION ComponentSetTarget(ci:ComponentInstance; target:ComponentInstance):LONGINT;
  172.  INLINE $2F3C,$4,$FFFA,$7000,$A82A;
  173.  
  174.  
  175. {****************************************************
  176. *                                                    *
  177. *               CALLS MADE BY Components             *
  178. *                                                    *
  179. ******************************************************}
  180.  
  181.  
  182. { *******************************************************
  183. * Component Management routines
  184. *******************************************************
  185.  }
  186. PROCEDURE SetComponentInstanceError(aComponentInstance: ComponentInstance;
  187.  theError: OSErr);
  188.  INLINE $700B,$A82A;
  189.  
  190. FUNCTION GetComponentRefcon(aComponent: Component): LONGINT;
  191.  INLINE $7010,$A82A;
  192. PROCEDURE SetComponentRefcon(aComponent: Component;theRefcon: LONGINT);
  193.  INLINE $7011,$A82A;
  194.  
  195. FUNCTION OpenComponentResFile(aComponent: Component): INTEGER;
  196.  INLINE $7015,$A82A;
  197. FUNCTION CloseComponentResFile(refnum: INTEGER): OSErr;
  198.  INLINE $7018,$A82A;
  199.  
  200.  
  201. { *******************************************************
  202. * Component Instance Management routines
  203. *******************************************************
  204.  }
  205. FUNCTION GetComponentInstanceStorage(aComponentInstance: ComponentInstance): Handle;
  206.  INLINE $700C,$A82A;
  207. PROCEDURE SetComponentInstanceStorage(aComponentInstance: ComponentInstance;
  208.  theStorage: Handle);
  209.  INLINE $700D,$A82A;
  210.  
  211. FUNCTION GetComponentInstanceA5(aComponentInstance: ComponentInstance): LONGINT;
  212.  INLINE $700E,$A82A;
  213. PROCEDURE SetComponentInstanceA5(aComponentInstance: ComponentInstance;
  214.  theA5: LONGINT);
  215.  INLINE $700F,$A82A;
  216.  
  217. FUNCTION CountComponentInstances(aComponent: Component): LONGINT;
  218.  INLINE $7013,$A82A;
  219.  
  220. {  useful helper routines for convenient method dispatching  }
  221. FUNCTION CallComponentFunction(params: ComponentParameters;func: ComponentFunction): LONGINT;
  222.  INLINE $70FF,$A82A;
  223. FUNCTION CallComponentFunctionWithStorage(storage: Handle;params: ComponentParameters;
  224.  func: ComponentFunction): LONGINT;
  225.  INLINE $70FF,$A82A;
  226. FUNCTION DelegateComponentCall(originalParams: ComponentParameters;
  227.  ci: ComponentInstance): LONGINT;
  228.  INLINE $7024,$A82A;
  229.  
  230. FUNCTION SetDefaultComponent(aComponent: Component;flags: INTEGER): OSErr;
  231.  INLINE $701E,$A82A;
  232. FUNCTION  OpenDefaultComponent(componentType: OSType; componentSubType: OSType ) : ComponentInstance;
  233.  INLINE $7021,$A82A;
  234. FUNCTION CaptureComponent(capturedComponent: Component;capturingComponent: Component): Component;
  235.  INLINE $701C,$A82A;
  236. FUNCTION UncaptureComponent(aComponent: Component): OSErr;
  237.  INLINE $701D,$A82A;
  238. FUNCTION RegisterComponentResourceFile(resRefNum:INTEGER;global:INTEGER):LONGINT;
  239.  INLINE $7014,$A82A;
  240.  
  241. {$ENDC} { UsingComponents }
  242.  
  243. {$IFC NOT UsingIncludes}
  244.  END.
  245. {$ENDC}
  246.  
  247.